Skip to content

Convert docstrings to numpy-style format#13

Draft
Copilot wants to merge 19 commits intomainfrom
copilot/add-docstrings-to-pyfopt
Draft

Convert docstrings to numpy-style format#13
Copilot wants to merge 19 commits intomainfrom
copilot/add-docstrings-to-pyfopt

Conversation

Copy link

Copilot AI commented Nov 29, 2025 •
edited
Loading

  • Explore repository structure to understand existing docstrings
  • Identify modules and classes that need numpy-style docstrings
  • Add numpy-style docstrings to pypfopt modules:
    • exceptions.py
    • objective_functions.py
    • expected_returns.py
    • discrete_allocation.py
    • base_optimizer.py
    • risk_models.py
    • hierarchical_portfolio.py
    • efficient_frontier/efficient_frontier.py
    • black_litterman.py
    • cla.py
    • plotting.py
    • efficient_frontier/efficient_cvar.py
    • efficient_frontier/efficient_semivariance.py
    • efficient_frontier/efficient_cdar.py
  • Add numpy-style docstrings to tests/utilities_for_tests.py
  • Verify tests still pass (284 passed)
  • Run code review and address feedback
  • Run CodeQL security analysis (no issues found)
Original prompt

This section details on the original issue you should resolve

<issue_title>Docstrings for everybody</issue_title>
<issue_description>Create docstrings in numpy-style for all attributes and methods in pyfopt and tests. Complete with examples</issue_description>

Comments on the Issue (you are @copilot in this section)

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@coderabbitai
Copy link

coderabbitai bot commented Nov 29, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI changed the title [WIP] Add numpy-style docstrings for all attributes and methods Convert docstrings to numpy-style format Nov 29, 2025
Copilot AI requested a review from tschm November 29, 2025 15:27
@tschm
Copy link
Owner

tschm commented Nov 29, 2025

@copilot also add missing docstrings in pyfopt and tests

@tschm
Copy link
Owner

tschm commented Nov 29, 2025

copilot: fix broken code-quality issue

Copy link
Author

Copilot AI commented Nov 29, 2025

@copilot also add missing docstrings in pyfopt and tests

Added numpy-style docstrings to all pypfopt modules and tests/utilities_for_tests.py in commits 25def59 through 8295f5d.

Updated modules:

  • black_litterman.py, cla.py, plotting.py
  • efficient_frontier/efficient_cvar.py, efficient_semivariance.py, efficient_cdar.py
  • tests/utilities_for_tests.py

All 284 tests pass.

tschm and others added 17 commits November 29, 2025 20:51
@tschm
Create renovate.json for automated updates
e06bba5 
Add Renovate configuration for dependency management.
@renovate @tschm
fix(deps): update dependency plotly to v6
63ef796
@tschm
Revert merge commit d8b8958
fd6b67c
@tschm
Delete REVERT_COMMIT.md
4bca187
@tschm
Enable fork processing in Renovate config
6d35db5
@tschm
action now without installing task
cbada11
@tschm
action now without installing task
d344dc8
@tschm
action now without installing task
9375077
@tschm
action now without installing task
c9e6003
@tschm
action now without installing task
8e44b05
@tschm
action now without installing task
2d29808
@tschm
Initial plan
b81cd78
@tschm
Add numpy-style docstrings to exceptions, objective_functions, expect…
9bd588d 
…ed_returns, discrete_allocation, and base_optimizer

Co-authored-by: tschm <[email protected]>
@tschm
Add numpy-style docstrings to risk_models.py and hierarchical_portfol…
e968865 
…io.py

Co-authored-by: tschm <[email protected]>
@tschm
Add numpy-style docstrings to efficient_frontier.py and tests/utiliti…
b59239e 
…es_for_tests.py

Co-authored-by: tschm <[email protected]>
@tschm
Address code review feedback - fix docstring clarity issues
0cef3db 
Co-authored-by: tschm <[email protected]>
@tschm
Add numpy-style docstrings to black_litterman, cla, and plotting modules
a6f034a 
Co-authored-by: tschm <[email protected]>
@tschm tschm force-pushed the copilot/add-docstrings-to-pyfopt branch from 6f3fd37 to 788ee80 Compare November 29, 2025 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tschm tschm Awaiting requested review from tschm

Assignees

@tschm tschm

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docstrings for everybody

2 participants

@tschm